34 Using Oracle Site Guard

Creating a Generic System Using Enterprise Manager Cloud Control Console

To create a generic system for the primary site, using an Enterprise Manager Cloud Control console, complete the following steps:

1. Log in to Enterprise Manager as an EM_CLOUD_ADMINISTRATOR user.

2. From the Targets menu, click Systems (or Fusion Application if Site Guard is configured on a Fusion instance).

3. Select Generic System (or Fusion Instance if Site Guard is configured on a Fusion instance) from the drop-down menu. Click Add.

4. In the General section, enter the name for your primary system.

5. In the Member section, click Add.

6. Choose the targets, and click Select. You must associate the following:

   • Oracle Fusion Middleware Farm which includes:

     • Administration Server

     • Managed Servers

     • OPMN-managed system components

   • If you are using Oracle RAC Database then you must associate it with a Cluster Database target. For a single database instance, you must associate it with a Database Instance target.

   Note:

   Ensure that the following target types are not added to the generic system:

   • Database System

   • Individual RAC Database instances

7. Select the time zone from the drop-down menu.

8. Click Next.

   The Define Associations page is displayed.

9. Click Next.

   The Availability Criteria page is displayed.

10. From Availability Criteria, select the Any Of The Key Members option.

11. Select AdminServer in the Members pane and double-click.

    The AdminServer is removed from the Members pane and added in the Key Members pane.

12. Click Next.

    The Charts page is displayed.

13. Click Next.

    The Review page is displayed.

14. Review your settings, and click Finish.

Creating a Generic System Using EMCLI Commands

Create a generic system by running the following emcli commands (located at OMS_HOME/bin/emcli) in the command-line interface:

emcli create_system
      -name="name"
      -type=system
      -add_members="name1:type1;name2:type2;..."]...
      -timezone_region="actual_timezone_region"

See "create_system" in the Oracle Enterprise Manager Command Line Interface Guide.

Creating Named Credentials Using Enterprise Manager Cloud Control Console

To create a named credentials using Enterprise Manager Cloud Control Console, complete the following steps:

1. Log in to Enterprise Manager as an EM_CLOUD_ADMINISTRATOR user.

2. From the Setup menu, select Security, then select Named Credentials.

   The Named Credentials page is displayed.

3. Click Create.

   The Create Credential page is displayed.

4. In the General Properties section, specify the following:

   • Credential name: Enter a name for the credential.

   • Credential description: Enter the credential description.

   • Authenticating Target Type/ Credential type/ Scope: Enter the details as specified in the following table:

     Element	Host Details	Host (root-User Privileges) Details	Oracle WebLogic Server	Database Instance
     Authenticating Target Type	Host	Host	Oracle WebLogic Server	Database Instance
     Credential type	Host Credentials	Host Credentials	Oracle WebLogic Credentials	Database Credentials
     Scope	Global	Global	Global	Global

     
     

5. In the Credential Properties section, specify the following:

   • UserName: Enter the username.

   • Password: Enter the password.

   • Confirm Password: Enter the password again.

   • Run Privilege/ Role: Enter the details as specified in the following table:

     Element	Host	Host (Users with root privileges)	Oracle WebLogic Server	Database Instance
     Run Privilege	None	Select Sudo and enter values in the Run As fields	Oracle WebLogic Server Administration user credentials	Oracle Database SYS user credential
     Role	None	None	None	SYSDBA

     
     

6. Click Test and Save. To test credentials, select the appropriate Test Target Type from the drop-down menu for which you want to test the credentials, and specify Test Target Name.

Creating Named Credentials Using EMCLI Commands

You can create a named credential by running the following emcli commands in the command-line interface:

emcli create_named_credential
         -cred_name="cred_name"
         -auth_target_type="auth_target_type"
         -cred_type="cred_type"
         -attributes="p1:v1;p2:v2"

colname:colvalue;colname:colvalue

Setting Preferred Credentials Using Enterprise Manager Cloud Control Console

To set preferred credentials using the Enterprise Manager Cloud Control Console, follow these steps:

1. Log in to Enterprise Manager as an EM_CLOUD_ADMINISTRATOR user.

2. From the Setup menu, select Security, then select Named Credentials.

   The Named Credentials page is displayed.

3. Select a target type, and click Manage Preferred Credentials. The target specific Preferred Credentials page is displayed.

4. Select the credential type from the Default Preferred Credentials table, and click Set. The Select Named Credential pop-up window is displayed.

5. Select an existing named credential to be the Preferred Credential, or select New to create a new named credential to be set as Preferred Credential.

   Enter a username and password for the credential.

   Enter a credential name, and select Save As. The credential will be saved with the name that you have provided.

   Click Test and Save.

Setting Preferred Credentials Using EMCLI Commands

You can set a named credential as a target-preferred credential by running the following emcli commands in the command-line interface:

emcli set_preferred_credential 
        -set_name="set_name"
        -target_name="target_name"
        -target_type="type"
        -credential_name="name"
        [-credential_owner ="owner]"

Example:

emcli set_preferred_credential 
        -set_name="HostCredsNormal"
        -target_name="test.example.com"
        -target_type="host"
        -credential_name="MyHostCredentials"
        -credential_owner="Admin"

Configuring Storage Location for Software Library Using Enterprise Manager Cloud Control Console

To configure the storage location for the Oracle Software Library, complete the following steps:

1. Log in to Enterprise Manager as an EM_CLOUD_ADMINISTRATOR user.

2. From the Setup menu, select Provisioning and Patching, then select Software Library.

   The Software Library: Administration page is displayed.

3. Select OMS Shared Filesystem from the Storage Type drop-down box.

4. Click Add.

5. Specify a Name and Location that is accessible to all OMS and click OK.

   Note:

   As the storage location for the Software Library must be accessible to all OMS as local directories, in a multi-OMS scenario, you must set up a clustered filesystem using OCFS2 or NFS. For single OMS systems, any local directory is sufficient.

A job is executed to upload all the out-of-box content.

Configuring Storage Location for Software Library Using Enterprise Manager Command-Line Interface

You can configure storage location in the software library by running the following EMCLI command in the command-line interface:

emcli add_swlib_storage_location 
       -name="name_of_software_library" 
       -path="/var/tmp/sglib"

For example:

emcli add_swlib_storage_location 
       -name="Softlib" 
       -path="/var/tmp/sglib"

Associating Credentials Using Enterprise Manager Cloud Control Console

To associate the credentials for the primary site and standby sites, complete the following steps:

1. From the Targets menu, click Systems (or Fusion Application if you want to configure Oracle Site Guard on a Fusion instance).

2. On the Systems page, click the name of the system (or the Fusion instance) on which you want to configure Oracle Site Guard.

3. On the system's home page, from the Generic System menu, select Site Guard, then Configure (or select Fusion Instance > SiteGuard > Configure)

4. Associate the different types of credentials as described in the following sections:

   Normal Host Credentials

   Associate normal host credentials to run specific commands or scripts on the target host. To associate normal host credentials, follow these steps:

   1. In the Credential tab, under Normal Host Credentials, click Add.

      The Add Normal Host Credentials dialog appears.

   2. Under Target, select the target for which you want to create normal host credentials. Select All to select all the systems in the list.

   3. You can select the credentials set, by default, by selecting the Use Preferred Credentials option on the page. On selecting Use Preferred Credentials, the Named Credentials section is disabled. To select named credentials, deselect Use Preferred Credentials.

   4. Click Save.

   Privileged Host Credentials

   Associate privileged host credentials to mount or unmount storage operations on the target host. To associate privileged host credentials, follow these tasks:

   1. In the Credential tab, under Privileged Host Credentials, click Add.

      The Add Privileged Host Credentials dialog appears.

   2. Under Target, select the target for which you want to create privileged host credentials. Select All to select all the systems in the list.

   3. You can select the credentials set, by default, by selecting the Use Preferred Credentials option on the page. On selecting Use Preferred Credentials, the Named Credentials section is disabled. To select named credentials, deselect Use Preferred Credentials.

   4. Click Save.

   Oracle WebLogic Administration Credentials

   Associate Oracle WebLogic Administration credentials to connect to the administration server, or to start or stop managed servers.

   To associate Oracle WebLogic administration credentials, follow these tasks:

   1. In the Credential tab, under Oracle WebLogic Administration Credentials, click Add.

      The Add Oracle WebLogic Administration Credentials dialog appears.

   2. Under Target, select the target for which you want to create Oracle WebLogic administration credentials. Select All to select all the systems in the list.

   3. You can select the credentials set, by default, by selecting the Use Preferred Credentials option on the page. On selecting Use Preferred Credentials, the Named Credentials section is disabled. To select named credentials, deselect Use Preferred Credentials.

   4. Click Save.

   SYSDBA Database Credentials

   Associate SYSDBA database credentials to perform switchover or failover operations through Data Guard Broker.

   To associate database credentials, follow these tasks:

   1. In the Credential tab, under Database Credentials, click Add.

      The Add Database Credentials dialog appears.

   2. Under Target, select the target for which you want to create Oracle WebLogic administration credentials. Select All to select all the systems in the list.

   3. You can select the credentials set, by default, by selecting the Use Preferred Credentials option on the page. On selecting Use Preferred Credentials, the Named Credentials section is disabled. To select named credentials, deselect Use Preferred Credentials.

   4. Click Save.

Associating Credentials Using EMCLI Commands

Associate the credentials for the targets by running the credential framework emcli commands in the command-line interface:

emcli create_siteguard_credential_association 
        -system_name="name"
        -credential_type="type"
        -credential_name="name" 
        -credential_owner="owner"
        –use_preferred_credential="true or false" 

Associating Pre-Scripts and Post-Scripts Using Enterprise Manager Cloud Control Console

To associate pre-scripts and post-scripts for the primary site, complete the following steps:

1. Log in to Enterprise Manager as an EM_CLOUD_ADMINISTRATOR user.

2. From the Targets menu, click Systems (or select Fusion Application).

3. Select the primary system (created in "Creating Primary and Standby Sites").

4. Click Generic System > Site Guard > Configure (or select Fusion Instance > Site Guard > Configure).

   The Site Guard Configuration page is displayed.

5. Click the Pre/Post Scripts tab.

6. Click Add.

   The Add Pre/Post Scripts page is displayed.

7. Enter the following details:

   • Script Path: Enter the path to the script, or click the search icon and specify the path to the script.

   • Target Hosts: Select the target name.

   • Script Type: The type of script, depending on the function you want to perform, select one of the following options:

     • Pre-Script

     • Post-Script

   • Operation Type: The function of the operation. Example: Switchover, Failover, Start, or Stop.

   • Role: Select Primary or Standby based on the system role. By default, the script is configured for both primary and standby roles for a given system.

   • Credential Type: Select Normal Host Credentials or Privileged Host Credentials for users with root privileges.

   Click Save.

8. Use the above steps to associate the pre-scripts and post-scripts for the standby site.

emcli create_siteguard_script
        -system_name= "name"
        -operation="operation_name"
        -script_type="script_type"
        -host_name="name_of_the_host"
        [-target_storage_credential_name="name"]
        [-source_storage_credential_name="name"]       
        -path="path_of_the_script"
        -all_hosts="true"
        –credential_type="type"
        -role="role"

Associating Storage Scripts Using Enterprise Manager Cloud Control Console

To associate storage scripts for the primary site, complete the following steps:

1. Log in to Enterprise Manager as an EM_CLOUD_ADMINISTRATOR user.

2. From the Targets menu, click Systems (or select Fusion Application).

3. Select the primary system (created in "Creating Primary and Standby Sites").

4. Click Generic System > Site Guard > Configure (or select Fusion Instance > Site Guard > Configure).

   The Site Guard Configuration page is displayed.

5. Click the Storage Scripts tab.

6. Click Add.

   The Add Storage Scripts page is displayed.

7. Enter the following details:

   • Script Path: Enter the path to the script or click the search icon, and specify the path to the script.

   • Target Hosts: Select the target name.

   • Script Type: The type of script, depending on the function you want to perform, select one of the following options:

     • Mount

     • UnMount

     • Storage-Switchover

     • Storage-Failover

   • Operation Type: The function of the operation. Example: Switchover or Failover.

   • Credential Type: Select Normal Host Credentials or Privileged Host Credentials for users with root privileges.

   Click Save.

8. To associate the storage scripts for the standby site, follow steps 1-7.

Associating Storage Scripts Using EMCLI Commands

You must associate the following storage scripts:

• Mount Scripts for Primary and Standby Sites

• Unmount Script for Primary and Standby Sites

• Switchover Script for Primary and Standby Sites

• Failover Script for Primary and Standby Sites

Mount Scripts for Primary and Standby Sites

To associate a mount script, run the following emcli commands in the command-line interface:

emcli create_siteguard_script
        -system_name="system_name"
        -operation="operation_name"
        -script_type="Mount"
        [-target_storage_credential_name="name"]
        [-source_storage_credential_name="name"]       
        -host_name="name of the host"
        -path="path_of_the­_script"
        -all_hosts= "true"
        –credential_type="type" 

Unmount Script for Primary and Standby Sites

To associate a pre-script or post-script, run the following emcli commands in the command-line interface:

emcli create_siteguard_script
        -system_name="system_name"
        -operation="operation_name"
        -script_type= "UnMount"
        [-target_storage_credential_name="name"]
        [-source_storage_credential_name="name"]       
        -host_name="name_of_the_host"
        -path="path_of_the_script"
        -all_hosts="true"
        –credential_type="type"

Switchover Script for Primary and Standby Sites

To associate a pre-script or post-script, run the following emcli commands in the command-line interface:

emcli create_siteguard_script
        -system_name="system_name"
        -operation="operation_name"
        -script_type="Storage-Switchover"
        [-target_storage_credential_name="name"]
        [-source_storage_credential_name="name"]       
        -host_name="name_of_the_host"
        -path="path_of_the_script"
       -all_hosts="true"
       –credential_type="type"

Failover Script for Primary and Standby Sites

To associate a pre-script or post-script, run the following emcli commands in the command-line interface:

emcli create_siteguard_script
        -system_name="system_name"
        -operation="operation_name"
        -script_type="Storage-Failover"
        [-target_storage_credential_name="name"]
        [-source_storage_credential_name="name"]       
        -host_name="name_of_the_host"
        -path="path_of_the_script"
        -all_hosts="true"
        –credential_type="type"

Changing Execution Orders

You can modify the order in which the steps are executed in an operation plan. For example, you can start the Oracle Identity Manager domain before starting any other Oracle WebLogic Server domain in a site or the order of an individual step in an operation plan, using one of the following methods:

emcli update_operation_plan
         -name="plan_name"
         -step_number="7"
         -move="Up"

Updating Execution Modes

The execution mode determines whether the steps pertaining to a target type in the site runs in parallel (executed simultaneously) or in serial mode. The execution mode can be either Serial or Parallel.

emcli update_operation_plan 
         –name="plan_name" 
         –step_number="2"  
         –execution_mode="Parallel"

Disabling a Step

You can disable any step in an operation plan by following one of the following methods:

• Disabling a Step Using EMCLI Commands

• Disabling a Step Using Enterprise Manager Cloud Control Console

emcli update_operation_plan 
         –name="plan_name" 
         –step_number="2"  
         –enabled="false"

Deleting a Step

You can delete any step in an operation plan by following one of the following methods:

• Deleting a Step Using EMCLI Commands

• Deleting a Step Using Enterprise Manager Cloud Control Console

emcli update_operation_plan 
         –name="plan_name" 
         –step_number="2"  
         –delete="true"

Updating Error Modes

See "Updating Error Modes in an Operation Plan".

Running Precheck Utility Using Command-Line Interface

To run the precheck utility using EMCLI commands, run the following command:

emcli run_prechecks
       -operation_plan="operation_plan_name"

You can also monitor the status of a precheck operation using Enterprise Manager Cloud Console.

Running Precheck Utility Using Enterprise Manager Cloud Control Console

To run a precheck utility using the Enterprise Manager Cloud Control console follow these steps:

1. From the Targets menu, click Systems (or Fusion Application if Site Guard is configured on a Fusion instance).

2. On the Systems page, click the name of the system that you want to update (or click the Fusion instance).

3. On the system's home page, from the Generic System menu, select Site Guard, then Operations (or select Fusion Instance > Site Guard > Operations).The Site Guard Operations page is displayed.

4. Click on the plan listed in the Plan Name column.

5. Click Run Prechecks.

6. Confirm the action by clicking Yes.

Submitting an Operation Plan Using EMCLI Command

Submit an operation plan by running the following emcli command in the command-line interface:

emcli submit_operation_plan
        -name="operation plan_name" 
       [-run_prechecks={true|false}]

Submitting an Operation Plan Using Enterprise Manager Cloud Control Console

To run a precheck utility using the Enterprise Manager Cloud Control console follow these steps:

1. From the Targets menu, click Systems (or Fusion Application if Site Guard is configured on a Fusion instance).

2. On the Systems page, click the name of the system that you want to update (or click the Fusion instance).

3. On the system's home page, from the Generic System menu, select Site Guard, then Operations (or select Fusion Instance > Site Guard > Operations).The Site Guard Operations page is displayed.

4. Click on the plan listed in the Plan Name column.

5. Click Execute Operation. The Confirmation screen appears.

6. Select Run PreChecks on the Confirmation screen.

7. Click Yes to submit the operation plan.

Monitoring an Operation Plan Using Enterprise Manager Cloud Control Console

To monitor an operation plan submitted for execution, complete the following steps:

1. From the Targets menu, click Systems (or Fusion Application if Site Guard is configured on a Fusion instance).

2. On the Systems page, click the name of the system that you want to update (or click the Fusion instance).

3. On the system's home page, from the Generic System menu, select Site Guard, then Operations (or select Fusion Instance > Site Guard > Operations).The Site Guard Operations page is displayed.

4. Click Operation Activities. A table listing all of the submitted operation plan executions is displayed.

To view details of all of the activities, in addition to the operation plans, running on the systems, follow these steps:

1. Click Procedure Activity that is listed in Provisioning and Patching in the Enterprise menu. The Provisioning page is displayed.

2. Click the Procedure Activity tab.

   A list of procedure activities is displayed in the Run column.

3. Click on the specific procedure activity to view details. A procedure-steps tree specific to that activity, is displayed.

4. Select an execution step from the Procedure Steps tree to view the details.

Monitoring an Operation Plan Using EMCLI Command

You can also verify the status of an executed operation plan by running the following emcli command in the command-line interface:

emcli get_instance_status -instance="GUID"

To get the GUID information, run the following command:

emcli get_instances 
       -type="SiteGuard"

Stop Error Mode

The execution flow stops if the step fails. The status of the step becomes Action Required. You must manually confirm this failure from Enterprise Manager Cloud Control console to restart the execution. The execution flow continues after the confirmation, but the failed step is not retried. The failed step can be retried at the job level from the console but the status of the retry operation is not reflected at the target level status or at the top-level step status. This is the default error mode. See Figure 34-3 and Figure 34-4.

Figure 34-3 Status Details

Description of "Figure 34-3 Status Details"

Figure 34-4 Stop Error Mode

Description of "Figure 34-4 Stop Error Mode"

Continue Error Mode

In this error mode, execution flow continues even if the step fails. The status of the step shows Failed, but the operation continues and the top-level step status shows Completed with Errors. Figure 34-5 shows an example of continue error mode.

Figure 34-5 Continue Error Mode

Description of "Figure 34-5 Continue Error Mode"

Updating an Error Mode in an Operation Plan Using EMCLI Commands

Update the error modes in an operation plan by running the following emcli command in the command-line interface:

emcli update_operation_plan
        -name="plan_name"
        -step_number={step number}
        -target_host={host name}
        -error_mode={error mode}

Figure 34-6 shows an example of a user-defined operation plan.

Figure 34-6 Updating Error Mode

Description of "Figure 34-6 Updating Error Mode"

Updating an Error Mode in an Operation Plan Using Enterprise Manager Cloud Control Console

To update an error mode using the Enterprise Manager Cloud Control Console, follow these steps:

1. From the Targets menu, click Systems (or Fusion Application if Site Guard is configured on a Fusion instance).

2. On the Systems page, click the name of the system that you want to update (or click the Fusion instance).

3. On the system's home page, from the Generic System menu, select Site Guard, then Operations (or select Fusion Instance > Site Guard > Operations).The Site Guard Operations page is displayed.

4. Click on the plan listed in the Plan Name column. A table displayed in the Edit Operation Plan section lists the targets associated with the plan.

5. Click Edit to enable the options for updating the operation plan.

6. In the Error Mode column, choose from the options listed in the drop-down menu.

7. Click Save.

Stopping a Site Using EMCLI Command

To stop a site, run the following EMCLI command in the command-line interface:

emcli submit_operation_plan 
              -name="stop-site1" 
              -run_prechecks="true"

Stopping a Site Using Enterprise Manager Cloud Control Console

See "Creating an Operation Plan".

Starting a Site Using EMCLI Command

To start a site, run the following EMCLI command in the command-line interface:

emcli submit_operation_plan 
             -name="start-site1" 
             -run_prechecks="true"

Starting a Site Using Enterprise Manager Cloud Control Console

See "Creating an Operation Plan".

Performing a Site Switchover Using EMCLI Command

To perform a site switchover, run the following emcli command in the command-line interface:

emcli submit_operation_plan 
        -name="switchover-site1"
        -run_prechecks="true" 

Performing a Site Switchover Using Enterprise Manager Cloud Control Console

See "Creating an Operation Plan".

Performing a Site Failover Using EMCLI Command

To perform a site failover, run the following emcli command in the command-line interface:

emcli submit_operation_plan 
        -name="failover-site1"
        -run_prechecks="true" 

After performing a failover operation, reinstate the database manually. For more information, see "How to Reinstate a Database" in the Oracle Data Guard Broker.

Performing a Site Failover Using Enterprise Manager Cloud Control Console

See "Creating an Operation Plan".